<!DOCTYPE HTML>

<html lang="en">
<head>

<title>OAuth2AuthorizationRequestRedirectWebFilter (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="OAuth2AuthorizationRequestRedirectWebFilter (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.oauth2.client.web.server</a></div>
<h2 title="Class OAuth2AuthorizationRequestRedirectWebFilter" class="title">Class OAuth2AuthorizationRequestRedirectWebFilter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.security.oauth2.client.web.server.OAuth2AuthorizationRequestRedirectWebFilter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>org.springframework.web.server.WebFilter</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">OAuth2AuthorizationRequestRedirectWebFilter</span>
extends java.lang.Object
implements org.springframework.web.server.WebFilter</pre>
<div class="block">This <code>WebFilter</code> initiates the authorization code grant or implicit grant flow by
redirecting the End-User's user-agent to the Authorization Server's Authorization
Endpoint.
<p>
It builds the OAuth 2.0 Authorization Request, which is used as the redirect
<code>URI</code> to the Authorization Endpoint. The redirect <code>URI</code> will include the
client identifier, requested scope(s), state, response type, and a redirection URI
which the authorization server will send the user-agent back to once access is granted
(or denied) by the End-User (Resource Owner).
<p>
By default, this <code>Filter</code> responds to authorization requests at the <code>URI</code>
<code>/oauth2/authorization/{registrationId}</code>. The <code>URI</code> template variable
<code>{registrationId}</code> represents the <a href="../../registration/ClientRegistration.html#getRegistrationId()"><code>registration identifier</code></a> of the client that is used for initiating the OAuth 2.0
Authorization Request.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../core/endpoint/OAuth2AuthorizationRequest.html" title="class in org.springframework.security.oauth2.core.endpoint"><code>OAuth2AuthorizationRequest</code></a>,
<a href="../AuthorizationRequestRepository.html" title="interface in org.springframework.security.oauth2.client.web"><code>AuthorizationRequestRepository</code></a>,
<a href="../../registration/ClientRegistration.html" title="class in org.springframework.security.oauth2.client.registration"><code>ClientRegistration</code></a>,
<a href="../../registration/ClientRegistrationRepository.html" title="interface in org.springframework.security.oauth2.client.registration"><code>ClientRegistrationRepository</code></a>,
<a target="_blank" href="https://tools.ietf.org/html/rfc6749#section-4.1">Section
4.1 Authorization Code Grant</a>,
<a target="_blank" href="https://tools.ietf.org/html/rfc6749#section-4.1.1">Section 4.1.1 Authorization Request
(Authorization Code)</a>,
<a target="_blank" href="https://tools.ietf.org/html/rfc6749#section-4.2">Section
4.2 Implicit Grant</a>,
<a target="_blank" href="https://tools.ietf.org/html/rfc6749#section-4.2.1">Section 4.2.1 Authorization Request
(Implicit)</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#%3Cinit%3E(org.springframework.security.oauth2.client.registration.ReactiveClientRegistrationRepository)">OAuth2AuthorizationRequestRedirectWebFilter</a></span>&#8203;(<a href="../../registration/ReactiveClientRegistrationRepository.html" title="interface in org.springframework.security.oauth2.client.registration">ReactiveClientRegistrationRepository</a>&nbsp;clientRegistrationRepository)</code></th>
<td class="colLast">
<div class="block">Constructs an <code>OAuth2AuthorizationRequestRedirectFilter</code> using the provided
parameters.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#%3Cinit%3E(org.springframework.security.oauth2.client.web.server.ServerOAuth2AuthorizationRequestResolver)">OAuth2AuthorizationRequestRedirectWebFilter</a></span>&#8203;(<a href="ServerOAuth2AuthorizationRequestResolver.html" title="interface in org.springframework.security.oauth2.client.web.server">ServerOAuth2AuthorizationRequestResolver</a>&nbsp;authorizationRequestResolver)</code></th>
<td class="colLast">
<div class="block">Constructs an <code>OAuth2AuthorizationRequestRedirectFilter</code> using the provided
parameters.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>reactor.core.publisher.Mono&lt;java.lang.Void&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#filter(org.springframework.web.server.ServerWebExchange,org.springframework.web.server.WebFilterChain)">filter</a></span>&#8203;(org.springframework.web.server.ServerWebExchange&nbsp;exchange,
org.springframework.web.server.WebFilterChain&nbsp;chain)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#setAuthorizationRequestRepository(org.springframework.security.oauth2.client.web.server.ServerAuthorizationRequestRepository)">setAuthorizationRequestRepository</a></span>&#8203;(<a href="ServerAuthorizationRequestRepository.html" title="interface in org.springframework.security.oauth2.client.web.server">ServerAuthorizationRequestRepository</a>&lt;<a href="../../../core/endpoint/OAuth2AuthorizationRequest.html" title="class in org.springframework.security.oauth2.core.endpoint">OAuth2AuthorizationRequest</a>&gt;&nbsp;authorizationRequestRepository)</code></th>
<td class="colLast">
<div class="block">Sets the repository used for storing <a href="../../../core/endpoint/OAuth2AuthorizationRequest.html" title="class in org.springframework.security.oauth2.core.endpoint"><code>OAuth2AuthorizationRequest</code></a>'s.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#setRequestCache(org.springframework.security.web.server.savedrequest.ServerRequestCache)">setRequestCache</a></span>&#8203;(<a href="../../../../web/server/savedrequest/ServerRequestCache.html" title="interface in org.springframework.security.web.server.savedrequest">ServerRequestCache</a>&nbsp;requestCache)</code></th>
<td class="colLast">
<div class="block">The request cache to use to save the request before sending a redirect.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.springframework.security.oauth2.client.registration.ReactiveClientRegistrationRepository)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>OAuth2AuthorizationRequestRedirectWebFilter</h4>
<pre>public&nbsp;OAuth2AuthorizationRequestRedirectWebFilter&#8203;(<a href="../../registration/ReactiveClientRegistrationRepository.html" title="interface in org.springframework.security.oauth2.client.registration">ReactiveClientRegistrationRepository</a>&nbsp;clientRegistrationRepository)</pre>
<div class="block">Constructs an <code>OAuth2AuthorizationRequestRedirectFilter</code> using the provided
parameters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clientRegistrationRepository</code> - the repository of client registrations</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.springframework.security.oauth2.client.web.server.ServerOAuth2AuthorizationRequestResolver)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OAuth2AuthorizationRequestRedirectWebFilter</h4>
<pre>public&nbsp;OAuth2AuthorizationRequestRedirectWebFilter&#8203;(<a href="ServerOAuth2AuthorizationRequestResolver.html" title="interface in org.springframework.security.oauth2.client.web.server">ServerOAuth2AuthorizationRequestResolver</a>&nbsp;authorizationRequestResolver)</pre>
<div class="block">Constructs an <code>OAuth2AuthorizationRequestRedirectFilter</code> using the provided
parameters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authorizationRequestResolver</code> - the resolver to use</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="setAuthorizationRequestRepository(org.springframework.security.oauth2.client.web.server.ServerAuthorizationRequestRepository)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setAuthorizationRequestRepository</h4>
<pre class="methodSignature">public final&nbsp;void&nbsp;setAuthorizationRequestRepository&#8203;(<a href="ServerAuthorizationRequestRepository.html" title="interface in org.springframework.security.oauth2.client.web.server">ServerAuthorizationRequestRepository</a>&lt;<a href="../../../core/endpoint/OAuth2AuthorizationRequest.html" title="class in org.springframework.security.oauth2.core.endpoint">OAuth2AuthorizationRequest</a>&gt;&nbsp;authorizationRequestRepository)</pre>
<div class="block">Sets the repository used for storing <a href="../../../core/endpoint/OAuth2AuthorizationRequest.html" title="class in org.springframework.security.oauth2.core.endpoint"><code>OAuth2AuthorizationRequest</code></a>'s.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authorizationRequestRepository</code> - the repository used for storing
<a href="../../../core/endpoint/OAuth2AuthorizationRequest.html" title="class in org.springframework.security.oauth2.core.endpoint"><code>OAuth2AuthorizationRequest</code></a>'s</dd>
</dl>
</li>
</ul>
<a id="setRequestCache(org.springframework.security.web.server.savedrequest.ServerRequestCache)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setRequestCache</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRequestCache&#8203;(<a href="../../../../web/server/savedrequest/ServerRequestCache.html" title="interface in org.springframework.security.web.server.savedrequest">ServerRequestCache</a>&nbsp;requestCache)</pre>
<div class="block">The request cache to use to save the request before sending a redirect.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>requestCache</code> - the cache to redirect to.</dd>
</dl>
</li>
</ul>
<a id="filter(org.springframework.web.server.ServerWebExchange,org.springframework.web.server.WebFilterChain)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>filter</h4>
<pre class="methodSignature">public&nbsp;reactor.core.publisher.Mono&lt;java.lang.Void&gt;&nbsp;filter&#8203;(org.springframework.web.server.ServerWebExchange&nbsp;exchange,
                                                          org.springframework.web.server.WebFilterChain&nbsp;chain)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>filter</code>&nbsp;in interface&nbsp;<code>org.springframework.web.server.WebFilter</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="OAuth2AuthorizationRequestRedirectWebFilter.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040e5ab88ed97cf","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
